<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>使用说明</title>
    <link rel="stylesheet" href="/lib/layui-v2.5.5/css/layui.css" media="all">
    <link rel="stylesheet" href="/lib/jq-module/zyupload/zyupload-1.0.0.min.css" media="all">
    <link rel="stylesheet" href="/css/public.css" media="all">
</head>
<body>
<div class="layuimini-container">
    <div class="layuimini-main">
        <pre class="layui-code">
            #### 介绍
            挡板系统是模拟上游接口请求响应的应用，用于减短调用链条，用于系统测试联调。
            请求支持get/post请求，请求参数支持json/xml/formData/queryString。
            响应参数支持json/xml/文件类型。

            #### 软件架构
            1.  分为管理端以及路由端
            2.  后端使用mybatis-plus,spring boot
            3.  数据库使用mysql
            4.  前端使用layui

            #### 安装教程
            1.  修改 application.properties 数据库配置项
            2.  连接数据库，执行data-baffle-sys-repository目录下resources的ddl/dml文件
            3.  mvn clean
            4.  mvn install  获取管理端jar以及路由端jar
            5.  分别使用 java -jar 命令启动两个应用
            6.  http://ip:9010/访问管理端页面  admin/admin登录
            7.  页面配置相关参数
            8.  上游调用路由端，测试

            #### 挡板系统管理端使用说明
            一，包含模块
                 1.  应用管理 - 应用增删改查 如 数据门户应用，外部数据平台应用，应用包含 code码/名称/注释，其中code码/名称唯一
                 2.  环境管理 - 环境增删改查 如 sit坏境,uat坏境，坏境包含 code码/名称/注释，其中code码/名称唯一
                 3.  数据源管理 - 数据源增删改查 如 qcc,huifa，数据源包含 code码/名称/注释，其中code码/名称唯一
                 4.  配置管理 - 配置增删改查，数据源包含 code码/名称/值，其中code码/名称唯一,谨慎操作
                 5.  接口管理 - 接口增删改查，接口包含 code码/名称/环境/应用/数据源/注释，其中code码/名称唯一,环境/应用/数据源/为下拉选项，选取上面已配置选项
                 6.  请求响应管理 - 对接口请求响应配对配置，特别注意请求报文类型为queryString以及fromData时，请求报文文件为json文件
                        queryString ：对于get请求http://ip:port/{app_code}/{env_code}/{datasource_code}/{interface_code}?a=1&b=2;
                                      a=1&b=2即为请求报文，请转化为json报文{"a" : 1, "b" : 2}上传。
                        fromData : 对于post请求，请求体内容为  a=1&b=2  。请转化为json报文{"a" : 1, "b" : 2}上传。
                        请参考postman http请求相关配置。
                 7.  失败模板管理 - 对接口失败请求响应配置,接口响应报文为非文件形式时必须配置


            二，配置步骤
                1.  配置应用/环境/数据源
                2.  配置管理配置
                    编码 : message_path_prefix  名称 : 报文存储路径前缀
                    编码 : route_address  名称 : 请求路由应用地址
                3.  配置接口
                4.  配置请求响应配对
                5.  配置失败模板

            #### 挡板系统路由端说明
            1.  报文类型响应请求url   http://{route_address}/route/{app_code}/{env_code}/{datasource_code}/{interface_code}
            2.  文件类型响应请求url   http://{route_address}/routeFile/{app_code}/{env_code}/{datasource_code}/{interface_code}
            route_address : 配置管理中配置的路由地址
            app_code : 应用管理-code码
            env_code : 环境管理-code码
            datasource_code : 数据源管理-code码
            interface_code : 接口管理-code码,即接口api不包含ip:port部分

            #### 注意事项
            1.  应用/环境/数据源 code码不能包含 “/”,且唯一, 否则无法使用
            2.  响应类型非文件类型的，失败模板必须配置，如若需要将失败原因体现出来，请在失败模板失败信息字段用\${resMsg}占位代替。如json类型失败报文  {"code" : 0000 , "msg" : "\${resMsg}"}



            #### 特别感谢
            前端参考使用了Mr.Chung / layui-mini的项目
            git地址:
            https://gitee.com/zhongshaofa/layuimini.git

        </pre>
    </div>
</div>
<script src="/lib/jquery-3.4.1/jquery-3.4.1.min.js" charset="utf-8"></script>
<script src="/lib/layui-v2.5.5/layui.js" charset="utf-8"></script>
</body>
</html>